Skip to content

Database version in features #5627

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

Merged
merged 4 commits into from
Jun 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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
35 changes: 28 additions & 7 deletions spec/features.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,41 @@
const request = require('../lib/request');

describe('features', () => {
it('requires the master key to get features', done => {
request({
it('should return the serverInfo', async () => {
const response = await request({
url: 'http://localhost:8378/1/serverInfo',
json: true,
headers: {
'X-Parse-Application-Id': 'test',
'X-Parse-REST-API-Key': 'rest',
'X-Parse-Master-Key': 'test',
},
}).then(fail, response => {
expect(response.status).toEqual(403);
expect(response.data.error).toEqual(
'unauthorized: master key is required'
});
const data = response.data;
expect(data).toBeDefined();
expect(data.features).toBeDefined();
expect(data.parseServerVersion).toBeDefined();
expect(data.database).toBeDefined();
expect(['MongoDB', 'PostgreSQL']).toContain(data.database.engine);
});

it('requires the master key to get features', async done => {
try {
await request({
url: 'http://localhost:8378/1/serverInfo',
json: true,
headers: {
'X-Parse-Application-Id': 'test',
'X-Parse-REST-API-Key': 'rest',
},
});
done.fail(
'The serverInfo request should be rejected without the master key'
);
} catch (error) {
expect(error.status).toEqual(403);
expect(error.data.error).toEqual('unauthorized: master key is required');
done();
});
}
});
});
13 changes: 12 additions & 1 deletion src/Adapters/Storage/Mongo/MongoStorageAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ export class MongoStorageAdapter implements StorageAdapter {
client: MongoClient;
_maxTimeMS: ?number;
canSortOnJoinTables: boolean;
databaseVersion: string;
engine: string;

constructor({
uri = defaults.DefaultMongoURI,
Expand All @@ -136,6 +138,7 @@ export class MongoStorageAdapter implements StorageAdapter {
this._collectionPrefix = collectionPrefix;
this._mongoOptions = mongoOptions;
this._mongoOptions.useNewUrlParser = true;
this.engine = 'MongoDB';

// MaxTimeMS is not a global MongoDB client option, it is applied per operation.
this._maxTimeMS = mongoOptions.maxTimeMS;
Expand Down Expand Up @@ -959,7 +962,15 @@ export class MongoStorageAdapter implements StorageAdapter {
}

performInitialization(): Promise<void> {
return Promise.resolve();
// databaseVersion
return this.connect()
.then(() => {
const adminDb = this.database.admin();
return adminDb.serverStatus();
})
.then(status => {
this.databaseVersion = status.version;
});
}

createIndex(className: string, index: any) {
Expand Down
9 changes: 9 additions & 0 deletions src/Adapters/Storage/Postgres/PostgresStorageAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -778,6 +778,8 @@ const buildWhereClause = ({ schema, query, index }): WhereClause => {

export class PostgresStorageAdapter implements StorageAdapter {
canSortOnJoinTables: boolean;
databaseVersion: string;
engine: string;

// Private
_collectionPrefix: string;
Expand All @@ -790,6 +792,7 @@ export class PostgresStorageAdapter implements StorageAdapter {
this._client = client;
this._pgp = pgp;
this.canSortOnJoinTables = false;
this.engine = 'PostgreSQL';
}

handleShutdown() {
Expand Down Expand Up @@ -2276,6 +2279,12 @@ export class PostgresStorageAdapter implements StorageAdapter {
})
.then(data => {
debug(`initializationDone in ${data.duration}`);
// databaseVersion
return this._client.query('SHOW server_version');
})
.then(versionData => {
// versionData is like [ { server_version: '11.3' } ]
this.databaseVersion = versionData[0].server_version;
})
.catch(error => {
/* eslint-disable no-console */
Expand Down
2 changes: 2 additions & 0 deletions src/Adapters/Storage/StorageAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ export type FullQueryOptions = QueryOptions & UpdateQueryOptions;

export interface StorageAdapter {
canSortOnJoinTables: boolean;
databaseVersion: string;
engine: string;

classExists(className: string): Promise<boolean>;
setClassLevelPermissions(className: string, clps: any): Promise<void>;
Expand Down
12 changes: 9 additions & 3 deletions src/Routers/FeaturesRouter.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export class FeaturesRouter extends PromiseRouter {
'/serverInfo',
middleware.promiseEnforceMasterKeyAccess,
req => {
const { config } = req;
const features = {
globalConfig: {
create: true,
Expand All @@ -33,9 +34,9 @@ export class FeaturesRouter extends PromiseRouter {
from: true,
},
push: {
immediatePush: req.config.hasPushSupport,
scheduledPush: req.config.hasPushScheduledSupport,
storedPushData: req.config.hasPushSupport,
immediatePush: config.hasPushSupport,
scheduledPush: config.hasPushScheduledSupport,
storedPushData: config.hasPushSupport,
pushAudiences: true,
localization: true,
},
Expand All @@ -51,10 +52,15 @@ export class FeaturesRouter extends PromiseRouter {
},
};

const dbAdapter = config.database.adapter;
return {
response: {
features: features,
parseServerVersion: version,
database: {
engine: dbAdapter.engine,
version: dbAdapter.databaseVersion,
},
},
};
}
Expand Down