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.

Sign up for GitHub

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

[TM] add spec for PermissionsAndroid #24886

Closed
wants to merge 6 commits into from
Closed

[TM] add spec for PermissionsAndroid #24886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cc751d1
[TM] add spec for PermissionsAndroid
May 16, 2019
eba4024
moves PermissionType to Spec file
May 16, 2019
68d987c
makes types more strict
May 16, 2019
0e0e926
adds check for platform
May 19, 2019
bc1b5eb
use inline string types
May 23, 2019
e20c745
adds warning for other platforms
May 23, 2019
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
57 changes: 57 additions & 0 deletions Libraries/PermissionsAndroid/NativePermissionsAndroid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow
*/

'use strict';
Copy link

Choose a reason for hiding this comment

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

prettier/prettier: Delete ⏎


import type {TurboModule} from 'RCTExport';
import * as TurboModuleRegistry from 'TurboModuleRegistry';

export type PermissionStatus = 'granted' | 'denied' | 'never_ask_again';
export type PermissionType =
| 'android.permission.READ_CALENDAR'
| 'android.permission.WRITE_CALENDAR'
| 'android.permission.CAMERA'
| 'android.permission.READ_CONTACTS'
| 'android.permission.WRITE_CONTACTS'
| 'android.permission.GET_ACCOUNTS'
| 'android.permission.ACCESS_FINE_LOCATION'
| 'android.permission.ACCESS_COARSE_LOCATION'
| 'android.permission.RECORD_AUDIO'
| 'android.permission.READ_PHONE_STATE'
| 'android.permission.CALL_PHONE'
| 'android.permission.READ_CALL_LOG'
| 'android.permission.WRITE_CALL_LOG'
| 'com.android.voicemail.permission.ADD_VOICEMAIL'
| 'android.permission.USE_SIP'
| 'android.permission.PROCESS_OUTGOING_CALLS'
| 'android.permission.BODY_SENSORS'
| 'android.permission.SEND_SMS'
| 'android.permission.RECEIVE_SMS'
| 'android.permission.READ_SMS'
| 'android.permission.RECEIVE_WAP_PUSH'
| 'android.permission.RECEIVE_MMS'
| 'android.permission.READ_EXTERNAL_STORAGE'
| 'android.permission.WRITE_EXTERNAL_STORAGE';

Copy link

Choose a reason for hiding this comment

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

prettier/prettier: Insert ;

export interface Spec extends TurboModule {
+checkPermission: (permission: PermissionType) => Promise<boolean>;

+requestPermission: (permission: PermissionType) => Promise<PermissionStatus>;

+shouldShowRequestPermissionRationale: (
permission: string,
) => Promise<boolean>;

+requestMultiplePermissions: (
permissions: Array<PermissionType>,
Copy link

Choose a reason for hiding this comment

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

prettier/prettier: Replace permissions:·Array<PermissionType>)·=>·Promise<{[permission:·PermissionType]:·PermissionStatus}> with ⏎····permissions:·Array<PermissionType>,⏎··)·=>·Promise<{[permission:·PermissionType]:·PermissionStatus}>;

) => Promise<{[permission: PermissionType]: PermissionStatus}>;
}

export default TurboModuleRegistry.getEnforcing<Spec>('PermissionsAndroid');
145 changes: 88 additions & 57 deletions Libraries/PermissionsAndroid/PermissionsAndroid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@
'use strict';

const NativeModules = require('../BatchedBridge/NativeModules');
const Platform = require('../Utilities/Platform');
import NativePermissionsAndroid from './NativePermissionsAndroid';

import type {
PermissionStatus,
PermissionType,
} from './NativePermissionsAndroid';

export type Rationale = {
title: string,
Expand All @@ -20,54 +27,48 @@ export type Rationale = {
buttonNeutral?: string,
};

type PermissionStatus = 'granted' | 'denied' | 'never_ask_again';
const PERMISSION_REQUEST_RESULT = Object.freeze({
GRANTED: 'granted',
DENIED: 'denied',
NEVER_ASK_AGAIN: 'never_ask_again',
});

const PERMISSIONS = Object.freeze({
READ_CALENDAR: 'android.permission.READ_CALENDAR',
WRITE_CALENDAR: 'android.permission.WRITE_CALENDAR',
CAMERA: 'android.permission.CAMERA',
READ_CONTACTS: 'android.permission.READ_CONTACTS',
WRITE_CONTACTS: 'android.permission.WRITE_CONTACTS',
GET_ACCOUNTS: 'android.permission.GET_ACCOUNTS',
ACCESS_FINE_LOCATION: 'android.permission.ACCESS_FINE_LOCATION',
ACCESS_COARSE_LOCATION: 'android.permission.ACCESS_COARSE_LOCATION',
RECORD_AUDIO: 'android.permission.RECORD_AUDIO',
READ_PHONE_STATE: 'android.permission.READ_PHONE_STATE',
CALL_PHONE: 'android.permission.CALL_PHONE',
READ_CALL_LOG: 'android.permission.READ_CALL_LOG',
WRITE_CALL_LOG: 'android.permission.WRITE_CALL_LOG',
ADD_VOICEMAIL: 'com.android.voicemail.permission.ADD_VOICEMAIL',
USE_SIP: 'android.permission.USE_SIP',
PROCESS_OUTGOING_CALLS: 'android.permission.PROCESS_OUTGOING_CALLS',
BODY_SENSORS: 'android.permission.BODY_SENSORS',
SEND_SMS: 'android.permission.SEND_SMS',
RECEIVE_SMS: 'android.permission.RECEIVE_SMS',
READ_SMS: 'android.permission.READ_SMS',
RECEIVE_WAP_PUSH: 'android.permission.RECEIVE_WAP_PUSH',
RECEIVE_MMS: 'android.permission.RECEIVE_MMS',
READ_EXTERNAL_STORAGE: 'android.permission.READ_EXTERNAL_STORAGE',
WRITE_EXTERNAL_STORAGE: 'android.permission.WRITE_EXTERNAL_STORAGE',
});

/**
* `PermissionsAndroid` provides access to Android M's new permissions model.
*
* See https://facebook.github.io/react-native/docs/permissionsandroid.html
*/

class PermissionsAndroid {
PERMISSIONS: Object;
RESULTS: Object;

constructor() {
/**
* A list of specified "dangerous" permissions that require prompting the user
*/
this.PERMISSIONS = {
READ_CALENDAR: 'android.permission.READ_CALENDAR',
WRITE_CALENDAR: 'android.permission.WRITE_CALENDAR',
CAMERA: 'android.permission.CAMERA',
READ_CONTACTS: 'android.permission.READ_CONTACTS',
WRITE_CONTACTS: 'android.permission.WRITE_CONTACTS',
GET_ACCOUNTS: 'android.permission.GET_ACCOUNTS',
ACCESS_FINE_LOCATION: 'android.permission.ACCESS_FINE_LOCATION',
ACCESS_COARSE_LOCATION: 'android.permission.ACCESS_COARSE_LOCATION',
RECORD_AUDIO: 'android.permission.RECORD_AUDIO',
READ_PHONE_STATE: 'android.permission.READ_PHONE_STATE',
CALL_PHONE: 'android.permission.CALL_PHONE',
READ_CALL_LOG: 'android.permission.READ_CALL_LOG',
WRITE_CALL_LOG: 'android.permission.WRITE_CALL_LOG',
ADD_VOICEMAIL: 'com.android.voicemail.permission.ADD_VOICEMAIL',
USE_SIP: 'android.permission.USE_SIP',
PROCESS_OUTGOING_CALLS: 'android.permission.PROCESS_OUTGOING_CALLS',
BODY_SENSORS: 'android.permission.BODY_SENSORS',
SEND_SMS: 'android.permission.SEND_SMS',
RECEIVE_SMS: 'android.permission.RECEIVE_SMS',
READ_SMS: 'android.permission.READ_SMS',
RECEIVE_WAP_PUSH: 'android.permission.RECEIVE_WAP_PUSH',
RECEIVE_MMS: 'android.permission.RECEIVE_MMS',
READ_EXTERNAL_STORAGE: 'android.permission.READ_EXTERNAL_STORAGE',
WRITE_EXTERNAL_STORAGE: 'android.permission.WRITE_EXTERNAL_STORAGE',
};

this.RESULTS = {
GRANTED: 'granted',
DENIED: 'denied',
NEVER_ASK_AGAIN: 'never_ask_again',
};
}
PERMISSIONS = PERMISSIONS;
RESULTS = PERMISSION_REQUEST_RESULT;

/**
* DEPRECATED - use check
Expand All @@ -77,11 +78,18 @@ class PermissionsAndroid {
*
* @deprecated
*/
checkPermission(permission: string): Promise<boolean> {
checkPermission(permission: PermissionType): Promise<boolean> {
console.warn(
'"PermissionsAndroid.checkPermission" is deprecated. Use "PermissionsAndroid.check" instead',
);
Copy link

Choose a reason for hiding this comment

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

curly: Expected { after 'if' condition.

return NativeModules.PermissionsAndroid.checkPermission(permission);
if (Platform.OS !== 'android') {
console.warn(
'"PermissionsAndroid" module works only for Android platform.',
);
return Promise.resolve(false);
}

return NativePermissionsAndroid.checkPermission(permission);
}

/**
Expand All @@ -90,8 +98,14 @@ class PermissionsAndroid {
*
* See https://facebook.github.io/react-native/docs/permissionsandroid.html#check
*/
check(permission: string): Promise<boolean> {
Copy link

Choose a reason for hiding this comment

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

curly: Expected { after 'if' condition.

return NativeModules.PermissionsAndroid.checkPermission(permission);
check(permission: PermissionType): Promise<boolean> {
if (Platform.OS !== 'android') {
console.warn(
'"PermissionsAndroid" module works only for Android platform.',
);
return Promise.resolve(false);
}
return NativePermissionsAndroid.checkPermission(permission);
}

/**
Expand All @@ -109,12 +123,19 @@ class PermissionsAndroid {
* @deprecated
*/
async requestPermission(
permission: string,
permission: PermissionType,
rationale?: Rationale,
): Promise<boolean> {
Copy link

Choose a reason for hiding this comment

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

curly: Expected { after 'if' condition.

console.warn(
'"PermissionsAndroid.requestPermission" is deprecated. Use "PermissionsAndroid.request" instead',
);
if (Platform.OS !== 'android') {
console.warn(
'"PermissionsAndroid" module works only for Android platform.',
);
return Promise.resolve(false);
}

const response = await this.request(permission, rationale);
return response === this.RESULTS.GRANTED;
}
Expand All @@ -126,11 +147,18 @@ class PermissionsAndroid {
* See https://facebook.github.io/react-native/docs/permissionsandroid.html#request
*/
async request(
Copy link

Choose a reason for hiding this comment

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

curly: Expected { after 'if' condition.

permission: string,
permission: PermissionType,
rationale?: Rationale,
): Promise<PermissionStatus> {
if (Platform.OS !== 'android') {
console.warn(
'"PermissionsAndroid" module works only for Android platform.',
);
return Promise.resolve(this.RESULTS.DENIED);
}

if (rationale) {
const shouldShowRationale = await NativeModules.PermissionsAndroid.shouldShowRequestPermissionRationale(
const shouldShowRationale = await NativePermissionsAndroid.shouldShowRequestPermissionRationale(
permission,
);

Expand All @@ -140,14 +168,12 @@ class PermissionsAndroid {
rationale,
() => reject(new Error('Error showing rationale')),
() =>
resolve(
NativeModules.PermissionsAndroid.requestPermission(permission),
),
resolve(NativePermissionsAndroid.requestPermission(permission)),
);
});
}
}
return NativeModules.PermissionsAndroid.requestPermission(permission);
return NativePermissionsAndroid.requestPermission(permission);
}

/**
Expand All @@ -158,11 +184,16 @@ class PermissionsAndroid {
* See https://facebook.github.io/react-native/docs/permissionsandroid.html#requestmultiple
*/
requestMultiple(
permissions: Array<string>,
Copy link

Choose a reason for hiding this comment

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

curly: Expected { after 'if' condition.

): Promise<{[permission: string]: PermissionStatus}> {
return NativeModules.PermissionsAndroid.requestMultiplePermissions(
permissions,
);
permissions: Array<PermissionType>,
): Promise<{[permission: PermissionType]: PermissionStatus}> {
if (Platform.OS !== 'android') {
console.warn(
'"PermissionsAndroid" module works only for Android platform.',
);
return Promise.resolve({});
}

return NativePermissionsAndroid.requestMultiplePermissions(permissions);
}
}

Expand Down