Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#IP-84] Change strict configuration to true #20

Merged
merged 8 commits into from
Apr 13, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions HandleNHNotificationCallActivity/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ export const ActivityInput = t.interface({

export type ActivityInput = t.TypeOf<typeof ActivityInput>;

const assertNever = (x: never): never => {
throw new Error(`Unexpected object: ${toString(x)}`);
};
// tslint:disable:no-any
const createUnexpecterError = (x: any): Error =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole point of assertNever is to have an assignment to a variable of type never; that means no other type can be passed to such function except never. This is an important mechanism to mark death branches in code (that is: conditions we assert are impossible to happen), and it is at foundation of every exhaustive check.

That said, the return type is not important because the functions either is never called or TS fails with wrong arguments error.

What about runtime? If this functions is executed, it means the variable contains a value which shape differs from the declared type. As this is a problem that can make the whole execution inconsistent, it's safer to throw an exception and let the error to bubble up.

new Error(`Unexpected object: ${toString(x)}`);

const telemetryClient = initTelemetryClient();

Expand All @@ -53,6 +53,7 @@ export const getCallNHServiceActivityHandler = (
context.log.info(
`${logPrefix}|${message.kind}|INSTALLATION_ID=${message.installationId}`
);

switch (message.kind) {
case CreateOrUpdateKind.CreateOrUpdateInstallation:
return createOrUpdateInstallation(
Expand Down Expand Up @@ -87,7 +88,7 @@ export const getCallNHServiceActivityHandler = (
return failure(e.message);
});
default:
assertNever(message);
throw createUnexpecterError(message);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment above

}
})
.fold<ActivityResult>(identity, success)
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"outDir": "dist",
"module": "commonjs",
"moduleResolution": "node",
"strict": false,
"strict": true,
"sourceMap": true,
"resolveJsonModule": true,
"skipLibCheck": true
Expand Down
3 changes: 2 additions & 1 deletion utils/notification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ class ExtendedNotificationHubService extends NotificationHubService {
});
};
// tslint:disable-next-line: no-string-literal no-any
return super["_buildRequestOptions"](
// @ts-ignore /* _buildRequestOptions is not defined in the Azure type NotificationHubService: the error is caused by strict=ture tsc configuration and will be ignored */
balanza marked this conversation as resolved.
Show resolved Hide resolved
return super._buildRequestOptions(
webResource,
body,
options,
Expand Down