Skip to content

Commit

Permalink
Revert "fix: decrease error handler verbosity on self recovering erro…
Browse files Browse the repository at this point in the history 
…rs (#9987)" (#10004)

This reverts commit 67ccf09.
  • Loading branch information
@david-mcafee
david-mcafee committed Jun 18, 2022
1 parent 8fb868f commit eb73ad7
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 171 deletions.
10 changes: 0 additions & 10 deletions packages/datastore/__tests__/helpers.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -994,13 +994,3 @@ export function internalTestSchema(): InternalSchema {
version: '1',
};
}

export function smallTestSchema(): Schema {
const schema = testSchema();
return {
...schema,
models: {
Model: schema.models.Model,
},
};
}
135 changes: 1 addition & 134 deletions packages/datastore/__tests__/subscription.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,9 @@
import Amplify from 'aws-amplify';
import { GRAPHQL_AUTH_MODE } from '@aws-amplify/api';
import { CONTROL_MSG as PUBSUB_CONTROL_MSG } from '@aws-amplify/pubsub';
import Observable from 'zen-observable-ts';
import {
SubscriptionProcessor,
USER_CREDENTIALS,
} from '../src/sync/processors/subscription';
import {
internalTestSchema,
Model as ModelType,
smallTestSchema,
} from './helpers';
import {
SchemaModel,
InternalSchema,
PersistentModelConstructor,
} from '../src/types';

let mockObservable = new Observable(() => {});

// mock graphql to return a mockable observable
jest.mock('@aws-amplify/api', () => {
return {
...jest.requireActual('@aws-amplify/api'),
graphql: jest.fn(() => mockObservable),
};
});
import { SchemaModel } from '../src/types';

describe('sync engine subscription module', () => {
test('owner authorization', () => {
Expand Down Expand Up @@ -588,117 +566,6 @@ describe('sync engine subscription module', () => {
});
});

describe('error handler', () => {
let Model: PersistentModelConstructor<ModelType>;

let subscriptionProcessor: SubscriptionProcessor;
const errorHandler = jest.fn();
beforeEach(async () => {
errorHandler.mockClear();
subscriptionProcessor = await instantiateSubscriptionProcessor({
errorHandler,
});
});

test('error handler once after all retires have failed', done => {
Amplify.Logger.LOG_LEVEL = 'DEBUG';
const debugLog = jest.spyOn(console, 'log');
const message = PUBSUB_CONTROL_MSG.REALTIME_SUBSCRIPTION_INIT_ERROR;
mockObservable = new Observable(observer => {
observer.error({
error: {
errors: [
{
message,
},
],
},
});
});

const subscription = subscriptionProcessor.start();
subscription[0].subscribe({
error: data => {
console.log(data);
console.log(errorHandler.mock.calls);

// call once each for Create, Update, and Delete
expect(errorHandler).toHaveBeenCalledTimes(3);
['Create', 'Update', 'Delete'].forEach(operation => {
expect(errorHandler).toHaveBeenCalledWith(
expect.objectContaining({
process: 'subscribe',
errorType: 'Unknown',
message,
model: 'Model',
operation,
})
);
// expect logger.debug to be called 6 times for auth mode (2 for each operation)
// can't use toHaveBeenCalledTimes because it is called elsewhere unrelated to the test
expect(debugLog).toHaveBeenCalledWith(
expect.stringMatching(
new RegExp(
`[DEBUG].*${operation} subscription failed with authMode: API_KEY`
)
)
);
expect(debugLog).toHaveBeenCalledWith(
expect.stringMatching(
new RegExp(
`[DEBUG].*${operation} subscription failed with authMode: AMAZON_COGNITO_USER_POOLS`
)
)
);
});

done();
},
});
}, 500);

async function instantiateSubscriptionProcessor({
errorHandler = () => null,
}) {
let schema: InternalSchema = internalTestSchema();

const { initSchema, DataStore } = require('../src/datastore/datastore');
const classes = initSchema(smallTestSchema());

({ Model } = classes as {
Model: PersistentModelConstructor<ModelType>;
});

const userClasses = {
Model,
};

await DataStore.start();
({ schema } = (DataStore as any).storage.storage);
const syncPredicates = new WeakMap();

const subscriptionProcessor = new SubscriptionProcessor(
schema,
syncPredicates,
{
aws_project_region: 'us-west-2',
aws_appsync_graphqlEndpoint:
'https://xxxxxxxxxxxxxxxxxxxxxx.appsync-api.us-west-2.amazonaws.com/graphql',
aws_appsync_region: 'us-west-2',
aws_appsync_authenticationType: 'API_KEY',
aws_appsync_apiKey: 'da2-xxxxxxxxxxxxxxxxxxxxxx',
},
() => [
GRAPHQL_AUTH_MODE.API_KEY,
GRAPHQL_AUTH_MODE.AMAZON_COGNITO_USER_POOLS,
],
errorHandler
);

return subscriptionProcessor;
}
});

const accessTokenPayload = {
sub: 'xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',
'cognito:groups': ['mygroup'],
Expand Down
48 changes: 21 additions & 27 deletions packages/datastore/src/sync/processors/subscription.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,7 @@ class SubscriptionProcessor {
transformerMutationType
].push(
queryObservable
.map(({ value }) => {
return value;
})
.map(({ value }) => value)
.subscribe({
next: ({ data, errors }) => {
if (Array.isArray(errors) && errors.length > 0) {
Expand Down Expand Up @@ -448,6 +446,23 @@ class SubscriptionProcessor {
errors: [],
},
} = subscriptionError;
try {
await this.errorHandler({
recoverySuggestion:
'Ensure app code is up to date, auth directives exist and are correct on each model, and that server-side data has not been invalidated by a schema change. If the problem persists, search for or create an issue: https://github.com/aws-amplify/amplify-js/issues',
localModel: null,
message,
model: modelDefinition.name,
operation,
errorType:
getSubscriptionErrorType(subscriptionError),
process: ProcessName.subscribe,
remoteModel: null,
cause: subscriptionError,
});
} catch (e) {
logger.error('Sync error handler failed with:', e);
}

if (
message.includes(
Expand All @@ -468,17 +483,16 @@ class SubscriptionProcessor {
operationAuthModeAttempts[operation] >=
readAuthModes.length
) {
// last auth mode retry. Continue with error
logger.debug(
`${operation} subscription failed with authMode: ${
readAuthModes[
operationAuthModeAttempts[operation] - 1
]
}`
);
logger.warn('subscriptionError', message);
return;
} else {
// retry with different auth mode. Do not trigger
// observer error or error handler
logger.debug(
`${operation} subscription failed with authMode: ${
readAuthModes[
Expand All @@ -494,27 +508,7 @@ class SubscriptionProcessor {
return;
}
}

try {
await this.errorHandler({
recoverySuggestion:
'Ensure app code is up to date, auth directives exist and are correct on each model, and that server-side data has not been invalidated by a schema change. If the problem persists, search for or create an issue: https://github.com/aws-amplify/amplify-js/issues',
localModel: null,
message,
model: modelDefinition.name,
operation,
errorType:
getSubscriptionErrorType(subscriptionError),
process: ProcessName.subscribe,
remoteModel: null,
cause: subscriptionError,
});
} catch (e) {
logger.error(
'Subscription error handler failed with:',
e
);
}
logger.warn('subscriptionError', message);

if (typeof subscriptionReadyCallback === 'function') {
subscriptionReadyCallback();
Expand Down

0 comments on commit eb73ad7

Please sign in to comment.