feat(android): migrate to support library apis #6129

manoldonev · 2018-07-27T15:40:17Z

Switch Android Activity/Fragment/FragmentManager to support library APIs (guideline from Google that this is the way to go as they are deprecating framework fragments from Android P onwards).

~~Note that migrating to support library FragmentManager implies the rather tedious switch from Animators to Animations API as well (as the supportlib manager only works with Animations).~~ (see comments below)

This should facilitate/enable future Android work with Material Design, shared element transitions, etc.

Fixes #5785
Related to #5789

BREAKING CHANGE:

NativeScript core framework now extends support library APIs versus native framework classes as per Google's latest guidelines:

NativeScript activities now extend android.support.v7.app.AppCompatActivity (vs android.app.Activity)
NativeScript fragments now extend android.support.v4.app.Fragment (vs android.app.Fragment)
NativeScript now works internally with android.support.v4.app.FragmentManager (vs android.app.FragmentManager)

Before:
Custom Android activities extended android.app.Activity

After:
Custom Android activities should extend android.support.v7.app.AppCompatActivity

To migrate the code of your custom activities follow the example below:

Before:

    @JavaProxy("org.myApp.MainActivity")
    class Activity extends android.app.Activity {
        // ...
    }

After:

    @JavaProxy("org.myApp.MainActivity")
    class Activity extends android.support.v7.app.AppCompatActivity {
        // ...
    }

Before:
Default fragment enter animation was Android version specific

After:
Default fragment enter animation is now fade animation for all Android versions. You can customise the transition per navigation entry or globally via the navigation transitions API

Before:
AndroidFragmentCallbacks interface exposed the following onCreateAnimator(...) method

export interface AndroidFragmentCallbacks {
    onCreateAnimator(fragment: any, transit: number, enter: boolean, nextAnim: number, superFunc: Function): any;
    // ...
}

After:
AndroidFragmentCallbacks interface now exposes the following onCreateAnimation(...) method instead (and onCreateAnimator(...) is now removed)

export interface AndroidFragmentCallbacks {
    onCreateAnimation(fragment: any, transit: number, enter: boolean, nextAnim: number, superFunc: Function): any;
    // ...
}

Before:
Transition class exposed the following abstract createAndroidAnimator(...) method

export class Transition {
    public createAndroidAnimator(transitionType: string): any;
    // ...
}

After:
Transition class now exposes the following abstract createAndroidAnimation(...) method instead (and `createAndroidAnimation(...) is now removed)

export class Transition {
    public createAndroidAnimation(transitionType: string): any;
    // ...
}

To migrate the code of your custom transitions follow the example below:

Before:

import * as transition from "tns-core-modules/ui/transition";

export class CustomTransition extends transition.Transition {
    constructor(duration: number, curve: any) {
        super(duration, curve);
    }

    public createAndroidAnimator(transitionType: string): android.animation.Animator {
        var scaleValues = Array.create("float", 2);
        switch (transitionType) {
            case transition.AndroidTransitionType.enter:
            case transition.AndroidTransitionType.popEnter:
                scaleValues[0] = 0;
                scaleValues[1] = 1;
                break;
            case transition.AndroidTransitionType.exit:
            case transition.AndroidTransitionType.popExit:
                scaleValues[0] = 1;
                scaleValues[1] = 0;
                break;
        }
        var objectAnimators = Array.create(android.animation.Animator, 2);
        objectAnimators[0] = android.animation.ObjectAnimator.ofFloat(null, "scaleX", scaleValues);
        objectAnimators[1] = android.animation.ObjectAnimator.ofFloat(null, "scaleY", scaleValues);
        var animatorSet = new android.animation.AnimatorSet();
        animatorSet.playTogether(objectAnimators);

        var duration = this.getDuration();
        if (duration !== undefined) {
            animatorSet.setDuration(duration);
        }
        animatorSet.setInterpolator(this.getCurve());

        return animatorSet;
    }
}

After:

import * as transition from "tns-core-modules/ui/transition";

export class CustomTransition extends transition.Transition {
    constructor(duration: number, curve: any) {
        super(duration, curve);
    }

    public createAndroidAnimation(transitionType: string): android.view.animation.Animation {
        const scaleValues = [];

        switch (transitionType) {
            case transition.AndroidTransitionType.enter:
            case transition.AndroidTransitionType.popEnter:
                scaleValues[0] = 0;
                scaleValues[1] = 1;
                break;
            case transition.AndroidTransitionType.exit:
            case transition.AndroidTransitionType.popExit:
                scaleValues[0] = 1;
                scaleValues[1] = 0;
                break;
        }
            
        const animationSet = new android.view.animation.AnimationSet(false);
        const duration = this.getDuration();
        if (duration !== undefined) {
            animationSet.setDuration(duration);
        }

        animationSet.setInterpolator(this.getCurve());
        animationSet.addAnimation(
            new android.view.animation.ScaleAnimation(
                scaleValues[0], 
                scaleValues[1], 
                scaleValues[0], 
                scaleValues[1]
            ));

        return animationSet;
    }
}

vakrilov

👍 👍 👍

There are 2 really minor breaking changes in the public APIs. I don't think they should stop this from going in, but we should note them along with the fact that we are switching to support Activity/Fragments:

frame.d.ts:
AndroidActivityCallbacks.onCreateAnimator -> AndroidActivityCallbacks.onCreateAnimation

transition.d.ts:
Transition.createAndroidAnimator -> Transition.createAndroidAnimation

vakrilov · 2018-07-31T11:05:06Z

tns-core-modules/ui/frame/fragment.transitions.android.ts

-    loadAnimatorMethod = manager.getClass().getDeclaredMethod("loadAnimator", javaClassArray(android.app.Fragment.class, java.lang.Integer.TYPE, java.lang.Boolean.TYPE, java.lang.Integer.TYPE));
-    if (loadAnimatorMethod != null) {
-        loadAnimatorMethod.setAccessible(true);
+    loadAnimationMethod = manager.getClass().getDeclaredMethod("loadAnimation", javaClassArray(android.support.v4.app.Fragment.class, java.lang.Integer.TYPE, java.lang.Boolean.TYPE, java.lang.Integer.TYPE));


Its worth debugging to see it the reflection we are using to get the default animations is still valid.
There is a check ( if (loadAnimationMethod != null)) on the next line that will prevent this code form crashing, nut it might be the case that this method does not exist at all.

Yep, I checked it when I added it -- method's good and the default enter animation is now a fast "push fade" (vs fade previously).

vakrilov · 2018-07-31T11:18:42Z

tns-core-modules/ui/transition/flip-transition.android.ts

 import { Transition, AndroidTransitionType } from "./transition";

-//http://developer.android.com/training/animation/cardflip.html
+// http://developer.android.com/training/animation/cardflip.html


Not sure how much of the code in this tutorial is still relevant as it uses Animators.

I left the link intact to keep the traceability as we are using similar logic (more or less) just with Animation APIs.

manoldonev · 2018-07-31T14:51:21Z

@vakrilov updated the PR body with the breaking changes section as discussed.

farfromrefug · 2018-08-01T06:21:16Z

@manoldonev great job! You should mention in my PR that the work is done here.
Thanks again

manoldonev · 2018-08-01T08:34:55Z

@farfromrefug thank you for your effort too!

farfromrefug · 2018-08-01T08:48:00Z

@manoldonev I am just glad it triggered the change! Amazing addition to Nativescript

shiv19 · 2018-08-01T09:45:29Z

@manoldonev
I'm on
nativescript@4.3.0-2018-08-01-12054
tns-android@4.3.0-2018-08-01-01
tns-core-modules@4.3.0-2018-07-31-02

In a project that is using NativeScript with JavaScript.
This is the stack trace I got when I built with the above configuration
It is something in the getDefaultAnimation method
stacktrace.txt

manoldonev · 2018-08-01T14:25:24Z

@shiv19 reproduced it in a project with nativescript-plugin-firebase. Working on it -- it is somehow related to the version of the support library that is used (maybe related to
NativeScript/nativescript-cli#3773)

manoldonev · 2018-08-02T08:42:07Z

About "Note that migrating to support library FragmentManager implies the rather tedious switch from Animators to Animations API as well (as the supportlib manager only works with Animations)" -- on further research it seems this was true only for older versions of the support library (up to ~26?). Newer versions (27.*) provide dual support for animations OR animators. However, due to some legacy code in NativeScript CLI we are mostly forcing the 26.0.0-alpha version of the support library in NativeScript apps (unless a specific plugin changes that). We will try to clean up the CLI and possibly revert the implementation here to use animators again instead of animations.

Fixes `Error: java.lang.CloneNotSupportedException: Class android.support.v4.app.FragmentManagerImpl$AnimationOrAnimator doesn't implement Cloneable` in specific projects. Related to #5785 Related to #6129 BREAKING CHANGE Before: Default fragment enter animation was Android version specific After: Default fragment enter animation is now fade animation for all Android versions You can customise the transition per navigation entry or globally via the [navigation transitions API]( https://docs.nativescript.org/core-concepts/navigation#navigation-transitions)

manoldonev · 2018-08-02T13:55:58Z

@shiv19 #6141 is now merged.

Necessary with NativeScript/NativeScript#6129 NOTE: This is not going to be released with {N} 4.2 (currently only in master branch)

lock · 2019-08-26T08:54:35Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

manoldonev added 3 commits July 27, 2018 17:29

feat: migrate to appcompat support library apis

6fcc692

chore: fix custom transition test

805ade8

chore: style fixes

78c4061

ghost assigned manoldonev Jul 27, 2018

ghost added the in progress label Jul 27, 2018

Merge branch 'master' into mdonev/appcompat-support-api

6cc4897

ns-bot added the cla: yes label Jul 27, 2018

manoldonev requested review from ADjenkov, vakrilov and vchimev July 30, 2018 11:16

vakrilov approved these changes Jul 31, 2018

View reviewed changes

Merge branch 'master' into mdonev/appcompat-support-api

3dfc6e2

manoldonev changed the title ~~feat: migrate to android support library apis~~ feat(android): migrate to support library apis Jul 31, 2018

manoldonev merged commit cf034dd into master Jul 31, 2018

ghost removed the in progress label Jul 31, 2018

manoldonev deleted the mdonev/appcompat-support-api branch July 31, 2018 15:48

manoldonev mentioned this pull request Aug 1, 2018

AppCompatActivity and shared element #5789

Closed

manoldonev mentioned this pull request Aug 1, 2018

fix(android): suppress reflection for default animations #6141

Merged

manoldonev added a commit to NativeScript/docs-v7 that referenced this pull request Aug 6, 2018

docs: update for support library activity api

f4e47a9

Necessary with NativeScript/NativeScript#6129 NOTE: This is not going to be released with {N} 4.2 (currently only in master branch)

This was referenced Aug 6, 2018

MERGE AFTER 5.0 IS RELEASED docs: update for support library activity api NativeScript/docs-v7#1301

Merged

chore: update demos inherit from supportlib activity NativeScript/nativescript-dev-webpack#624

Merged

manoldonev mentioned this pull request Aug 6, 2018

refactor: update getSupportFragmentManager cast #6155

Merged

This was referenced Aug 16, 2018

[next] frame content disappears on app suspend / resume in tabview scenario #6188

Closed

fix(android-next): force frame fragment disposal on unload #6189

Merged

manoldonev mentioned this pull request Sep 21, 2018

feat: remove requirement for Android Support Repository local installation NativeScript/nativescript-cli#3923

Merged

5 tasks

This was referenced Oct 12, 2018

refactor: restore animators api usage #6403

Merged

refactor: restore animators api usage NativeScript/tests-app-transitions#6

Merged

lock bot locked and limited conversation to collaborators Aug 26, 2019

Uh oh!

feat(android): migrate to support library apis #6129

feat(android): migrate to support library apis #6129

Uh oh!

Conversation

manoldonev commented Jul 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vakrilov left a comment

Choose a reason for hiding this comment

Uh oh!

vakrilov Jul 31, 2018

Choose a reason for hiding this comment

Uh oh!

manoldonev Jul 31, 2018

Choose a reason for hiding this comment

Uh oh!

vakrilov Jul 31, 2018

Choose a reason for hiding this comment

Uh oh!

manoldonev Jul 31, 2018

Choose a reason for hiding this comment

Uh oh!

manoldonev commented Jul 31, 2018

Uh oh!

farfromrefug commented Aug 1, 2018

Uh oh!

manoldonev commented Aug 1, 2018

Uh oh!

farfromrefug commented Aug 1, 2018

Uh oh!

shiv19 commented Aug 1, 2018

Uh oh!

manoldonev commented Aug 1, 2018

Uh oh!

manoldonev commented Aug 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manoldonev commented Aug 2, 2018

Uh oh!

lock bot commented Aug 26, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

manoldonev commented Jul 27, 2018 •

edited

Loading

manoldonev commented Aug 2, 2018 •

edited

Loading